-
Notifications
You must be signed in to change notification settings - Fork 2.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[doc] Fix of the documentation's build #21967 #22180
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The Doxygen configuration file does not allow the generation of the documentation. To solve this problem, I made some changes: * I excluded symbolic links to avoid infinite recurrences. * I excluded the "third_party" which causes too many troubles. I disabled the transformation of the warning into an error because there's few warning during documentation generation. I have deliberately not made any changes so as not to be too intrusive. I invite the managers of these parts to make corrections that will certainly be more relevant than mine. I put logs file on ticket. Doc entry point: ./docs/html/index.html Build command: CHIP_NAME="xxxx" CHIP_VERSION="v x.y.z" doxygen ./docs/Doxyfile
github-actions
bot
added
the
documentation
Improvements or additions to documentation
label
Aug 26, 2022
PR #22180: Size comparison from c990d26 to 3477e66 Increases (4 builds for cc13x2_26x2, cyw30739, esp32, psoc6)
Decreases (1 build for cc13x2_26x2)
Full report (32 builds for bl602, cc13x2_26x2, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, psoc6, telink)
|
PR #22180: Size comparison from 7870328 to e041ddf Increases (4 builds for bl602, cc13x2_26x2, psoc6, telink)
Decreases (2 builds for cc13x2_26x2, cyw30739)
Full report (43 builds for bl602, cc13x2_26x2, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, psoc6, telink)
|
Damian-Nordic
approved these changes
Aug 30, 2022
pullapprove
bot
requested review from
anush-apple,
arkq,
Byungjoo-Lee,
bzbarsky-apple,
carol-apple,
chrisdecenzo,
chshu,
chulspro,
dhrishi,
electrocucaracha,
erjiaqing,
franck-apple,
gjc13,
harsha-rajendran,
hawk248,
isiu-apple,
jelderton,
jepenven-silabs,
jmartinez-silabs,
jtung-apple,
kghost,
lazarkov and
mlepage-google
August 30, 2022 14:37
pullapprove
bot
requested review from
mrjerryjohns,
msandstedt,
rgoliver,
robszewczyk,
saurabhst,
selissia,
tcarmelveilleux,
tecimovic,
tehampson,
turon,
vijs,
vivien-apple,
wbschiller,
woody-apple,
xylophone21 and
yunhanw-google
August 30, 2022 14:37
andy31415
approved these changes
Aug 30, 2022
pullapprove
bot
added
review - approved
and removed
review - pending
ACCEPTED for 1.0 master
labels
Aug 30, 2022
Accepted for 1.0: documentation-specific change. |
isiu-apple
pushed a commit
to isiu-apple/connectedhomeip
that referenced
this pull request
Sep 16, 2022
…ip#22180) The Doxygen configuration file does not allow the generation of the documentation. To solve this problem, I made some changes: * I excluded symbolic links to avoid infinite recurrences. * I excluded the "third_party" which causes too many troubles. I disabled the transformation of the warning into an error because there's few warning during documentation generation. I have deliberately not made any changes so as not to be too intrusive. I invite the managers of these parts to make corrections that will certainly be more relevant than mine. I put logs file on ticket. Doc entry point: ./docs/html/index.html Build command: CHIP_NAME="xxxx" CHIP_VERSION="v x.y.z" doxygen ./docs/Doxyfile
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
The Doxygen configuration file does not allow the generation of the documentation.
Overview of changes
To solve this problem, I made some changes:
I disabled the transformation of the warning into an error because there are some warnings when generating the documentation.
I deliberately did not make any changes outside of Doxygen so as not to be too intrusive.
I invite the maintainers of these parts to make corrections that will certainly be more relevant than mine.
...The result is not perfect...
Test
Log file is attached.
Entry point of the doc : ./docs/html/index.html
Build command: CHIP_NAME="xxxx" CHIP_VERSION="v x.y.z" doxygen ./docs/Doxyfile
build.log